Resource URL: /platform/<<version=3>>/event/alert-conditions/<ID>

    Overview: This resource applies the standard collection pattern to
              individual alert conditions.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the alert-condition.

       URL: GET /platform/<<version=3>>/event/alert-conditions/<ID>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "alert-conditions": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies under what conditions and over which channel an alert should be sent", 
            "properties": {
              "name": {
                "type": "string", 
                "description": "Unique identifier."
              }, 
              "channel_ids": {
                "items": {
                  "type": "integer"
                }, 
                "minimum": 0, 
                "type": "array", 
                "description": "Channels for alert"
              }, 
              "interval": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions"
              }, 
              "eventgroup_ids": {
                "uniqueItems": true, 
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Event Group IDs to be alerted"
              }, 
              "transient": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition."
              }, 
              "limit": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added"
              }, 
              "categories": {
                "uniqueItems": true, 
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Event Group categories to be alerted"
              }, 
              "id": {
                "type": "string", 
                "description": "Unique identifier."
              }, 
              "condition": {
                "ignore_case": "true", 
                "enum": [
                  "NEW", 
                  "NEW EVENTS", 
                  "ONGOING", 
                  "SEVERITY INCREASE", 
                  "SEVERITY DECREASE", 
                  "RESOLVED"
                ], 
                "type": "string", 
                "description": "Trigger condition for alert"
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the alert-condition

       URL: PUT /platform/<<version=3>>/event/alert-conditions/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies under what conditions and over which channel an alert should be sent", 
  "properties": {
    "channel_ids": {
      "items": {
        "type": "integer"
      }, 
      "minimum": 0, 
      "type": "array", 
      "description": "Channels for alert"
    }, 
    "interval": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions"
    }, 
    "eventgroup_ids": {
      "uniqueItems": true, 
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Event Group IDs to be alerted"
    }, 
    "transient": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition."
    }, 
    "limit": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added"
    }, 
    "categories": {
      "uniqueItems": true, 
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Event Group categories to be alerted"
    }, 
    "condition": {
      "ignore_case": "true", 
      "enum": [
        "NEW", 
        "NEW EVENTS", 
        "ONGOING", 
        "SEVERITY INCREASE", 
        "SEVERITY DECREASE", 
        "RESOLVED"
      ], 
      "type": "string", 
      "description": "Trigger condition for alert"
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the alert-condition.

          URL: DELETE /platform/<<version=3>>/event/alert-conditions/<ID>

There are no query arguments for this method.

There is no JSON response body for this method.
